/*
 * Bytecode Analysis Framework
 * Copyright (C) 2005 University of Maryland
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package edu.umd.cs.findbugs.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.annotation.meta.TypeQualifierNickname;
import javax.annotation.meta.When;

/**
 * The annotated element could be null under some circumstances.
 * 
 * In general, this means developers will have to read the documentation
 * to determine when a null value is acceptable and whether it is neccessary
 * to check for a null value. 
 *
 * When this annotation is applied to a method it applies to the method return value. 
 **/
@Documented
@Target({ElementType.FIELD, ElementType.METHOD,
		 ElementType.PARAMETER, 
		 ElementType.LOCAL_VARIABLE})
@Retention(RetentionPolicy.CLASS)
@javax.annotation.Nonnull(when=When.UNKNOWN)
@TypeQualifierNickname
public @interface Nullable {

}
